home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / amiga / opalvisn / opalprs1.lha / update.doc < prev   
Text File  |  1993-01-13  |  5KB  |  178 lines
  1.  
  2.                   OpalPlayer and ARexx
  3.  
  4.  
  5. OpalPlayer  now  has  two  different  methods  of being used with
  6. ARexx.   The  first  method involves creating a script file using
  7. OpalPresents!   and  then  using  ARexx  commands  to  effect the
  8. transition  timing  (if ARexx advance method selected) as well as
  9. to abort the script and change display priorities and options.
  10.  
  11. The  second  method is to use OpalPlayer as an ARexx host without
  12. using a script.  To use this method, simply run OpalPlayer giving
  13. it the 'ARexxHost' keyword, i.e:
  14.  
  15.          OpalPlayer ARexxHost
  16.  
  17. When  in ARexxHost mode, the player will wait for ARexx commands,
  18. processing them as they come in.
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                       AREXX Commands
  25.  
  26.  
  27.                  ADVANCE   Usage: Advance
  28.  
  29. If  OpalPlayer is waiting for and advance command for the current
  30. image,  (as  set  in  OpalPresents!)  the Player will perfrom the
  31. transition to the next image.
  32.  
  33. Note: This command has no meaning in ARexxHost mode.
  34.  
  35.  
  36.                     STOP   Usage: Stop
  37.  
  38. This command will remove the OpalVision display and terminate the
  39. player  program.   This  command  is  now recognised in Timer and
  40. Button advance modes.
  41.  
  42.  
  43.               ADDPRELOAD   Usage: AddPreLoad FileName
  44.  
  45. If the image specified by 'FileName' is not present in the active
  46. preload  list  it  will  be  loaded  into  memory.  FileName must
  47. include the full path.
  48.  
  49. One  images  have  been  added into the preload list, they remain
  50. resident and can be used repeatedly without any disk access.
  51.  
  52.  
  53.  
  54.              FREEPRELOAD   Usage: FreePreLoad ImageName
  55.  
  56. If  the  image  specified  by 'FileName' is present in the active
  57. preload list, it will be removed from memory.
  58.  
  59.  
  60.  
  61.                LOADIMAGE   Usage: LoadImage ImageName
  62.  
  63. This   command  will  load  an  image  into  memory,  which  will
  64. subsequently  be  used  in  a  transition.  This command does not
  65. effect  the  current  display  but will load an image into memory
  66. only.  If the image is already preloaded (resident) the imagename
  67. will be noted and this command will return immediately.
  68.  
  69. If  the  ImageName  is  'Blank'  a  blank  (black)  image will be
  70. inserted.
  71.  
  72. Note: This command can only be used in ARexxHost mode.
  73.  
  74.  
  75.               TRANSITION   Usage: TransType TransTime [Tokens]
  76.  
  77. This  command will perform a transition from the current contents
  78. of  the OpalVision framebuffer to the image specified by the last
  79. LoadImage  command.
  80.  
  81. NOTE:   a  LoadImage command must be issued before executing this
  82. command,  if  not  Transition  will  return  an  error.  Once the
  83. transition  has  completed, the loaded image will be removed from
  84. memory (unless it is a resident image).
  85.  
  86. The parameters are:
  87.  
  88. TransType  =  0  to  19.   Number  of  the transition to perform.
  89. Transition  0  is  'Bang' and 19 is the vertical venetian effect.
  90. All  other  transitions  are  as seen on the OpalPresents screen,
  91. numbered left to right, top to bottom.
  92.  
  93. TransTime  is  the  duration  of  the  transition  in 10th's of a
  94. second.  e.g to perform a fade over 2 seconds, use
  95.  
  96.         Transition 1 20
  97.  
  98. 'Tokens'  can  be  a  series  of  tokens  equivalent  to the ones
  99. specified  in  the  OpalPlayer script files.  These tokens can be
  100. used to set display priorities, enable stencils etc.  All display
  101. options  set  with  these  tokens  will  take  effect  AFTER  the
  102. transition  has been performed.  The following list is the tokens
  103. currently accepted:
  104.  
  105.             Display Priorities:
  106.      OpalOnly   - OpalVision graphics only.
  107.      AmigaOnly  - Amiga graphics only.
  108.      OpalPri    - Dual Opal/Amiga display with Opal in front.
  109.      AmigaPri   - Dual Opal/Amiga display with Amiga in front.
  110.      LiveOnly   - Live video only.
  111.  
  112.             Other Display Options:
  113.      PriStencil - Enable Priority stencil.
  114.      Alpha      - Enable Alpha Channel.
  115.      Genlock    - Enable Genlocking.
  116.      Latch      - Latch the OpalVision display on.
  117.  
  118. Example:
  119.          LoadImage 'gfx:pic1'
  120.          Transition 1 20 OpalPri PriStencil
  121.  
  122. Note: This command can only be used in ARexxHost mode.
  123.  
  124.  
  125.               DISPLAYPRI   Usage: DisplayPri Token
  126.  
  127. This  command can be used to change the current display priority.
  128. 'Token' must be one of the 5 tokens mentioned above.
  129.  
  130.  
  131.               PRISTENCIL   Usage: PriStencil [Enable|Disable]
  132.  
  133. This  command  can  be  used  to  switch  on  or off the priority
  134. stencil.  Either 'Enable' or 'Disable' must be specified.
  135.  
  136.  
  137.                  GENLOCK   Usage: Genlock [Enable|Disable]
  138.  
  139. This  command  can  be  used  to switch on or off the genlocking.
  140. Either 'Enable' or 'Disable' must be specified.
  141.  
  142.  
  143.                DISPLATCH   Usage: DispLatch [Enable|Disable]
  144.  
  145. This command can be used to latch or unlatch the current display.
  146. If the display is latched, any amiga animations or iff viewers
  147. can be used over the 24bit display. Either 'Enable' or 'Disable'
  148. must be specified.
  149.  
  150.  
  151.                    ALPHA   Usage: Alpha [Enable|Disable]
  152.  
  153. If  the  current  image has a alpha channel information attached,
  154. this  command  will enable or disable the use of this imformation
  155. for keying over live video.
  156.  
  157.  
  158.                 EXAMPLE SCRIPT
  159.  
  160. /* OpalPlayer ARexx host test.
  161.  */
  162.  
  163. Address 'OpalPlayer_Rexx'
  164.  
  165. LoadImage 'gfx:hic'
  166. transition 2 40
  167.  
  168. LoadImage 'gfx:analyse'
  169. Pristencil enable
  170. DisplayPri AmigaPri
  171. transition 5 40
  172.  
  173. address command wait 3
  174.  
  175. LoadImage 'blank'
  176. transition 1 40 OpalPri
  177. stop
  178.